home *** CD-ROM | disk | FTP | other *** search
/ The Original Shareware 1.1 / The Original Shareware (WeMake CDs)(Volume 1.1)(CDs, Inc)(1993).iso / 16 / textout.zip / TEXTOUT5.DOC next >
Text File  |  1988-08-02  |  17KB  |  343 lines

  1.  
  2.  
  3.  
  4.  
  5.                                    TextOut/5
  6.                   WordPerfect 5.0 to ASCII Conversion Program
  7.                                   Version 1.0
  8.                                        
  9.                         Another Shareware Product from:
  10.                               CrossCourt Systems
  11.                                        
  12.                                   Created by:
  13.                                   Chris Wolf
  14.                (Member - Association of Shareware Professionals)
  15.                                        
  16.                                        
  17.                                        
  18.       FEATURES
  19.       
  20.       TextOut/5 is a standalone program for IBM-compatible computers that
  21.       converts WordPerfect 5.0 document files to ASCII.  It improves upon
  22.       WordPerfect's Text Out command, in both the "DOS Text" and "generic
  23.       word processing" formats.
  24.       
  25.       1.  TextOut/5's default format is similar to WordPerfect's "DOS
  26.           Text" option, except that TextOut/5 expands tabs to spaces, a
  27.           feature that was dropped from WordPerfect in version 5.0.  In a
  28.           similar vein, TextOut/5 formats hanging indents properly, while
  29.           WordPerfect 5.0 does not.
  30.       2.  In its "generic word processing format", TextOut/5 drops all of
  31.           the unwanted spaces that WP inserts for centered or right flush
  32.           text.  This makes it easier to align these items properly in
  33.           the target word processor.
  34.       3.  TextOut/5 can mark certain font attributes, such as
  35.           underlining, in the ASCII file by using special characters.
  36.           This is useful if you want to transfer the ASCII file to
  37.           another word processor and restore the attributes.
  38.       4.  TextOut/5 can be run from the DOS command line, and will accept
  39.           wildcard filespecs.
  40.       5.  TextOut/5 converts files at about twice the speed of Word
  41.           Perfect.
  42.       6.  TextOut/5 can be used by someone who does not have WordPerfect,
  43.           but who may have received WordPerfect files from elsewhere.
  44.       7.  TextOut/5 can recover text from files that have been damaged to
  45.           the point where WordPerfect refuses to load them.
  46.       
  47.       TextOut/5's default ASCII format is very much like that of the
  48.       WordPerfect 4.2 "Save as DOS Text File" command.  Indents, tabs and
  49.       centering are emulated by the use of spaces, and each line is ended
  50.       with a hard carriage return.  The format is suitable for use for
  51.       electronic mail and many other purposes.  See the "OPTIONS" section
  52.       for information on the other formats TextOut/5 can produce.
  53.       
  54.       Text/Out5 omits most page-formatting characteristics.  This means
  55.       that, for example, the left margin is not expanded to spaces; the
  56.       top and bottom margins are not expanded to blank lines; page
  57.       breaks, headers, footers, and page numbering are omitted; and top-
  58.       to-bottom centering is ignored.
  59.       
  60.  
  61.                                        2
  62.  
  63.       If a document has been "Fast-Saved", TextOut/5 will still convert
  64.       it, but will warn you that the formatting may not be correct.
  65.       Unless you have recently made a change in margins or tabs without
  66.       having gone to the end of the document, the ASCII format will
  67.       probably be fine.  If you use TextOut/5 often and have problems on
  68.       Fast-Saved documents, you may want to change your setup options to
  69.       disable Fast Saves.
  70.       
  71.       
  72.       USE
  73.       
  74.       To run TextOut/5, type TO5 followed by two filenames.  The first
  75.       one is the name of the input (WP 5.0) file, the second is the
  76.       output (ASCII) file.  For example:
  77.           TO5 TEST.DOC TEST.ASC
  78.       
  79.       The file names can include wildcards, employed in the same way as
  80.       with the DOS COPY command.  For example,
  81.           TO5 A:P*.*
  82.       would convert all files starting with the letter P in the current
  83.       directory on drive A: to ASCII files of the same name on the
  84.       current drive and directory, while
  85.           TO5 \DOCS \TEXT\*.TXT
  86.       would convert all files from the \DOCS directory to the \TEXT
  87.       directory while changing their extensions to TXT.
  88.       
  89.       If a file already exists under the output name, it will be replaced
  90.       without warning.  If the input and output names are the same,
  91.       TextOut/5 will not proceed with the conversion.
  92.       
  93.       
  94.       OPTIONS
  95.       
  96.       TextOut/5 has many options which can be invoked by "switches" on
  97.       the command line.  These switches must start with a slash or a
  98.       hyphen.  This is followed by a letter identifying the option, and,
  99.       for some of the switches, a numeric value.  The identifying letter
  100.       can be either upper or lower case and the switches can appear
  101.       anywhere on the command line -- before, after, or in between the
  102.       filenames.  There must not be any spaces between the slash, the
  103.       letter and the number.  A command that used the /T, /B, and /C
  104.       switches might look like:
  105.           TO5 /T /B60 /C62 EXAMPLE.DOC \NEW\EXAMPLE.ASC
  106.       
  107.       There are eight options controlled by twelve switches (keep
  108.       reading, it will make sense in a minute).
  109.       
  110.           "Generic Format" Options
  111.           
  112.           These two options would usually be used together to produce a
  113.           format similar to WordPerfect's "generic word processing"
  114.           option.  This format has tabs and carriage returns exactly
  115.           where the operator originally typed them, with no spaces or
  116.           "soft returns" added.  This is usually the best format to use
  117.           if you want to transfer the resulting ASCII file to another
  118.           word processor.
  119.  
  120.                                        3
  121.  
  122.       
  123.           1.  /R     keep only hard <R>eturns
  124.       
  125.               This will keep only WordPerfect's hard returns from the
  126.               ASCII file, in effect turning each paragraph into a single
  127.               long line of text.
  128.               
  129.               
  130.           2.  /T     keep <T>ab characters
  131.           
  132.               This will keep tab characters in the ASCII file, rather
  133.               than replacing them with spaces.  This differs slightly
  134.               from WordPerfect, in that it will also suppress the use of
  135.               spaces to position text that is centered between the
  136.               margins or flush to the right margin.
  137.               
  138.               
  139.           Font Attribute Options
  140.           
  141.           These eight options, composed of four pairs of switches, allow
  142.           the start and end of certain font attributes to be marked in
  143.           the ASCII file using special characters.  They would usually be
  144.           used in conjunction with the generic-format options if you were
  145.           moving the ASCII file to another word processor and wanted to
  146.           restore the original format.
  147.           
  148.           The naming of these switches is intended to be mnemonic, but is
  149.           limited somewhat by the use of single letters within a 26-
  150.           character alphabet.  The first switch of each pair, used for
  151.           the "start attribute" code, should remind you of the function,
  152.           while the switch for the "end attribute" code simply follows
  153.           the first alphabetically.  Thus /B for bold is paired with /C,
  154.           and /U for underline is paired with /V.  Subscripting and
  155.           superscripting are less obvious, with /I and /J intended to
  156.           remind you of things often used as subscripts, while /X and /Y
  157.           might be used as superscripts (powers).
  158.           
  159.           1.  /B# and /C#      <B>oldface
  160.           
  161.               There are several ways to use these and the following
  162.               paired options.
  163.               
  164.               If you want to mark boldface text using the default
  165.               characters of { (ASCII 125) at the beginning and } (ASCII
  166.               123) at the end, all you have to do is specify /B by
  167.               itself.
  168.               
  169.               If you want to mark boldface text, but want to use
  170.               different characters, perhaps because the default
  171.               characters may occur in your document, you can specify
  172.               either or both of the /B and /C switches with a numeric
  173.               ASCII value (as indicated by the # symbol in the switch
  174.               template above).  In the case of the /B switch, the ASCII
  175.               character corresponding to the numeric value will be used
  176.               to mark the start of boldface; the value given for the /C
  177.               switch will be used to mark the end.
  178.  
  179.                                        4
  180.  
  181.               
  182.               The value must be decimal (i.e., hexadecimal is not
  183.               allowed) and cannot be zero.  Only a single ASCII value can
  184.               be used for each switch; it is not possible to mark with a
  185.               multi-character code, such as [B].  So, for example, /B17
  186.               would cause a Ctrl-Q to be used at the start of bold text,
  187.               while /C35 would put # symbols at the end of bold text.
  188.               
  189.               In some ways the use of ASCII values is inconvenient, but
  190.               DOS puts restrictions on the use of many characters on the
  191.               command line, so something like /B< /C> will not work.  The
  192.               use of numbers gives maximum flexibility.
  193.               
  194.           2.  /I# and /J#      subscripts
  195.           
  196.               Read the description of /B and /C above for a full
  197.               explanation of how the paired options work.  If you use /I
  198.               without a number, the beginning of a subscript will be
  199.               marked with ~ (ASCII 126) and the ending with | (ASCII
  200.               124).
  201.               
  202.           3.  /U# and /V#      <U>nderlining
  203.           
  204.               Read the description of /B and /C above for a full
  205.               explanation of how the paired options work.  If you use /U
  206.               without a number, the beginning of underlining will be
  207.               marked with < (ASCII 60) and the ending with > (ASCII 62).
  208.               
  209.           4.  /X# and /Y#      superscripts
  210.           
  211.               Read the description of /B and /C above for a full
  212.               explanation of how the paired options work.  If you use /X
  213.               without a number, the beginning of a superscript will be
  214.               marked with ^ (ASCII 94) and the ending with \ (ASCII 92).
  215.               
  216.               
  217.           Other Options
  218.           
  219.           1.  /P#    tab-fill <P>itch
  220.           
  221.               Word Perfect 5.0 stores all tabs, indents, centering, etc.
  222.               using absolute measurements, i.e. inches.  It also allows
  223.               you to intermix different font sizes at will.  This can
  224.               cause some inconsistencies in spacing when converting to
  225.               ASCII files, where an inch is a meaningless measurement and
  226.               all characters are the same size.
  227.               
  228.               When expanding tabs and the like to spaces, TextOut/5
  229.               translates WP's internal measurements to 10 spaces per
  230.               inch.  If a document is written primarily in another pitch,
  231.               this may not give quite the right spacing.  This would be
  232.               most noticeable in tables, particularly if you used a very
  233.               small font size (large pitch).  In this case, the columns
  234.               in the table might all run together.  You can specify a
  235.               different pitch for the tab filling by using, for example,
  236.               /P12 to indicate 12 pitch.
  237.  
  238.                                        5
  239.  
  240.               
  241.           2.  /H     <H>eaderless WP file
  242.           
  243.               This option can recover the text from a damaged file that
  244.               may not be usable with WP.  There are many different kinds
  245.               of damage that may occur to a file, however, and the
  246.               quality of the results from TextOut/5 may vary widely.
  247.               
  248.               BEFORE YOU USE THIS OPTION YOU MUST REMOVE THE HEADER FROM
  249.               THE FILE.  If you don't, the program will still work, but
  250.               you will probably recover less text than if you had removed
  251.               the header.  To do this, you must have a byte-level editor
  252.               such as WP's Program Editor, QDOS's QED, the Norton
  253.               Utilities, etc. and you must know how to use it on binary
  254.               files.  Using the editor, find the first recognizable text
  255.               in the file and delete everything that precedes it.  Don't
  256.               delete anything else, even though much of it may look like
  257.               junk.  Save the result under a new name.
  258.               
  259.               Run TextOut/5 using this new headerless file as input and
  260.               specifying the /H option.  Chances are that you will want
  261.               to use the generic-format options as well as the attribute-
  262.               marking options, because they will produce a file that can
  263.               be most easily restored to its original format.  Remember
  264.               that the output file will be ASCII, so you should not
  265.               Retrieve it directly into Word Perfect.  Use the Retrieve
  266.               command found as option 2 on the Text In/Out - DOS Text
  267.               menu.
  268.               
  269.               If the first attempt is unsatisfactory, try editing the
  270.               headerless file again, this time looking for large blocks
  271.               of a single character.  Try deleting these and running
  272.               TextOut/5 again.
  273.               
  274.               
  275.       REGISTRATION AND DISTRIBUTION
  276.       
  277.       TextOut/5 is Copyright 1988, CrossCourt Systems.
  278.       
  279.       Chris Wolf, the author of TextOut/5, is a member of the Association
  280.       of Shareware Professionals (ASP), a group dedicated to high
  281.       standards in the development, documentation, and support of
  282.       shareware products.
  283.       
  284.       If you find TextOut/5 to be a useful and valuable product, please
  285.       register your copy with CrossCourt Systems by sending payment to
  286.       the address below.  In the spirit of shareware, the amount is left
  287.       up to you to determine, based on the number of copies you are
  288.       using, the frequency of use, and the amount of time it saves you.
  289.       Those who send $15 or more will be sent one subsequent update (be
  290.       sure to specify what version you currently have).  VISA and
  291.       MasterCard are accepted.  Microsoft C source code is available at
  292.       personal-use and commercial-use rates.
  293.       
  294.       TextOut/5 may be distributed to others, as long as 1) the program
  295.       is not altered in any way, 2) this documentation file is always
  296.  
  297.                                        6
  298.  
  299.       included, and 3) no charge is made for such distribution beyond a
  300.       modest disk preparation fee.  For bulletin board distribution,
  301.       please use the file name TEXTOUT5.ARC or TXTOUT.ARC
  302.       
  303.       TextOut/5 has been tested and performs its functions essentially as
  304.       described above, without causing any damage to the computer in use
  305.       or any of its files.  However, all users are responsible for
  306.       backing up their own files, and CrossCourt Systems assumes no
  307.       responsibility for any damage or losses incurred as a result of its
  308.       use.
  309.       
  310.       Chris Wolf can be reached on Compuserve at 72446,2704.  If you
  311.       encounter problems with any conversion, I would like to hear about
  312.       them.  If you have suggestions for improvements, they would be
  313.       appreciated also.
  314.       
  315.       CrossCourt Systems
  316.       1521 Greenview Ave.
  317.       East Lansing, MI 48823
  318.       (517) 332-4353
  319.       
  320.       
  321.       Other shareware from CrossCourt Systems
  322.       
  323.       ConvDW - converts IBM Displaywrite 3 or 4 files to ASCII, offering
  324.       many of the same options as TextOut/5.  Unlike WP 5.0, DW has a
  325.       space-formatted, text-out-like command, but does not have a
  326.       generic-format option.  ConvDW, of course, offers both.  Usually
  327.       found as CONVDW.ARC on bulletin boards.
  328.       
  329.       ConvDCA - converts IBM DCA/RFT format files to ASCII, offering many
  330.       of the same options as TextOut/5.  Usually found as CNVDCA.ARC or
  331.       CONVDCA.ARC on bulletin boards.
  332.       
  333.       TextCon - a program to reformat ASCII files before importing them
  334.       to your word processor.  TextCon performs extremely intelligent
  335.       "cleaning" operations on your ASCII files, so you have less editing
  336.       to do after importing them.  It removes unneeded hard carriage
  337.       returns (even with tricky paragraph formats), strips excess spaces
  338.       used for margins or justification, and does other processing to get
  339.       the cleanest conversion possible.  Can also perform other unusual
  340.       formatting tasks such as splitting long lines in generic-format
  341.       files.  Usually found as TEXTCN.ARC or TEXTCON.ARC on bulletin
  342.       boards.
  343.